/*
XPTracker - Alternative Agile Tracking Tool
Copyright (C) 2006-2009  Stephen Starkey

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
*/
package org.xptracker.services.reports;

import org.xptracker.domain.Domain;
import org.xptracker.domain.Story;

import java.io.Serializable;
import java.util.Date;

public interface TimeSegmentReportRecipient extends Serializable {

  /**
   * A story was added at the given date, and was worth the given amount.  Being
   * "added" means the story meets the entry criteria.
   * @param domain
   * @param date date the story was added
   * @param s story that was added
   * @param amount amount (in points or hours)
   */
  void storyAdded(Domain domain, Date date, Story s, double amount);

  /**
   * A story was removed at the given date, and was worth the given amount.  Being
   * "removed" means the story no longer meets the entry criteria and doesn't meet 
   * the exit criteria either.
   * @param domain
   * @param date date the story was removed
   * @param s story that was removed
   * @param amount amount (in points or hours)
   */
  void storyRemoved(Domain domain, Date date, Story s, double amount);

  /**
   * A story was completed at the given date, and was worth the given amount.  Being
   * "completed" means the story meets the exit criteria.
   * @param domain
   * @param date date the story was completed
   * @param s story that was completed
   * @param amount amount (in points or hours)
   */
  void storyCompleted(Domain domain, Date date, Story s, double amount);

  /**
   * A story remains in the segment at the given date, and was worth the given amount.
   * @param domain
   * @param date date the story remains
   * @param s story that remains
   * @param amount amount (in points or hours)
   */
  void storyRemains(Domain domain, Date date, Story s, double amount);
}
